/*
 * Alloy Analyzer
 * Copyright (c) 2002 Massachusetts Institute of Technology
 *
 * The Alloy Analyzer is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * The Alloy Analyzer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with the Alloy Analyzer; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package alloy.ast;

import alloy.semantic.LocalScope;

public abstract class FormulaPara extends TreeNode implements Paragraph {

    /**
     * index of name in child list
     */
    private static final int NAME_INDEX = 0;

    /**
     * index of formula in child list
     */
    private static final int FORMULA_INDEX = 1;

    /**
     * local scope of this
     */
    private LocalScope _localScope = new LocalScope();

    public FormulaPara(Location location_, QualifiedName name_, FormulaSeq formula_) {
        super(location_, name_, formula_);
    }


    public FormulaPara(QualifiedName name_, FormulaSeq formula_) {
        super(Location.UNKNOWN, name_, formula_);
    }



    //GET AND SET METHODS

    /**
     * gets the name of this
     * @return the {@link QualifiedName}
     */
    public QualifiedName getName() {
        return (QualifiedName)childAt(NAME_INDEX);
    }

    /** set the Name of this */
    public void setName(QualifiedName newChild_) {
        setChild(NAME_INDEX, newChild_);
    }

    /**
     * gets the formula of this
     * @return the {@link FormulaSeq}
     */
    public FormulaSeq getFormula() {
        return (FormulaSeq)childAt(FORMULA_INDEX);
    }

    /** set the Formula of this */
    public void setFormula(FormulaSeq newChild_) {
        setChild(FORMULA_INDEX, newChild_);
    }

    /**
     * get the local scope of this
     * @return the LocalScope
     */
    public LocalScope getLocalScope() {
        return _localScope;
    }

    /**
     * set the local scope of this
     * @param localScope_ the new LocalScope
     */
    public void setLocalScope(LocalScope localScope_) {
        _localScope = localScope_;
    }


    /**
     * accept an AST visitor
     * @param visitor_ the visitor
     */
    protected void acceptVisitor(ASTVisitor visitor_) {
        visitor_.visit(this);
    }

    /**
     * accept a returning AST visitor
     * @param visitor_ the visitor
     * @return the Object returned by the visitor
     */
    protected Object acceptReturnVisitor(ASTReturnVisitor visitor_) {
        return visitor_.visit(this);
    }

    public String nodeString() {
        return getName().getId().nodeString() + " " + getFormula().nodeString();
    }

    public String toString() {
        return nodeString();
    }
}
